home *** CD-ROM | disk | FTP | other *** search
/ The 640 MEG Shareware Studio 2 / The 640 Meg Shareware Studio CD-ROM Volume II (Data Express)(1993).ISO / sunrise / acnfn17.zip / ACNFN.DOC < prev    next >
Text File  |  1993-03-08  |  12KB  |  313 lines
  1.              Automated Network/Conference Listing Generator
  2.  
  3.                                   v1.7
  4.  
  5.                               PCBoard 14.5a
  6.  
  7.                                    by
  8.  
  9.                               Al Lawrence
  10.  
  11.                             Sunrise-80  BBS
  12.                          (404) 256-9525 (Data)
  13.                          (404) 705-9104 (Data)
  14.                   (404) 256-9518 (Voice, 9am-9:30pm EST)
  15.                             Fido 1:133/410
  16.  
  17.  
  18.  
  19.  
  20.                               DESCRIPTION
  21.                               ___________
  22.  
  23.  
  24. The Automated Network/Conference Listing Generator (ACNFN) is a utility that
  25. creates the conference display file. Most Sysops use an editor to create the
  26. conference listing, more commonly called CNFN. As you add/change/delete
  27. conferences you end up spending hours trying to realign and colorize the
  28. display. If you happen to add a whole network, you could very well spend
  29. more time fixing the conference listing, than creating the conferences
  30. themselves. This utility does not create any extraneous files on disk and
  31. uses the CNAMES file as input. There is no need to create a second file for
  32. the colorized listing, as the program uses the @X variables made available
  33. in PCBoard v14.5. Just about everything is configurable, from verbage to colors.
  34.  
  35.  
  36.  
  37.                               INSTALLATION
  38.                               ____________
  39.  
  40.  
  41.    Installation is fairly easy and straight-forward. The following steps and
  42.    examples should have you up and running in a very short period of time.
  43.  
  44.      (1) Create a Configuration file with a name of your choice.
  45.  
  46.      (2) Run the program using the following command line:
  47.  
  48.                ACNFN   xxxx.CFG
  49.  
  50.          Where xxxx = the name used in (1) above.
  51.  
  52.  
  53.  
  54.  
  55.                              CONFIGURATION FILE
  56.                              __________________
  57.  
  58.      Line 1.   Sunrise-80 BBS
  59.      Line 2.   Al Lawrence
  60.      Line 3.   00000000
  61.      Line 4.   INPUT=C:\PCB\MAIN\CNAMES
  62.      Line 5.   OUTPUT=C:\PCB\GEN\CNFN
  63.      Line 6.   SORT=N
  64.      Line 7.   NUMCOL=LEFT
  65.      LINE 8.   NDESC=RIM:RIME
  66.      Line 9.   NETCONF=RIM:2:100:P
  67.      Line 10.  CONF=LOC:Sunrise Doors:1:1:p
  68.      Line 11.  XCNF=@X06
  69.      Line 12.  XTYP=@X0C
  70.      Line 13.  XCFN=@X0A
  71.      Line 14.  XHDB=@X1A
  72.      Line 15.  XBBS=@X1F
  73.      Line 16.  XNET=@X57
  74.      Line 17.  XBBG=@X1F
  75.      Line 18.  XMRE=@X8C
  76.      Line 19.  BLINE=R = Restricted
  77.  
  78.  
  79.  
  80. __________________________________________________________________________
  81.  
  82. Line 1.  Your BBS Name. Will Display on Heading and is mandatory
  83.  
  84. Line 2.  Sysop's First and Last Name. Does not display, but is mandatory.
  85.  
  86. Line 3.  Registration Number
  87.  
  88. Line 4.  Full Pathname\Filename of the CNAMES file. This entry is
  89.          mandatory.
  90.  
  91. Line 5.  Full Pathname\Filename of the output file that will contain
  92.          the conference listing. This entry is mandatory.
  93.  
  94. Line 6.  This entry indicates the SORT sequence for the conference displays.
  95.          N = Display conference's in conference NUMBER sequence.
  96.          A = Display conference's in conference NAME sequence.
  97.          This entry is mandatory.
  98.  
  99. Line 7.  This entry indicates where you would like to have the conference
  100.          number displayed.
  101.          LEFT  = Display it to the LEFT  of the conference name
  102.          RIGHT = Display it to the RIGHT of the conference name.
  103.          This entry is mandatory.
  104.  
  105. Line 8.  This entry assigns a UNIQUE 3 character ID and description to each
  106.          Network on your system. The format is|  NETWORK ID:NETWORK NAME
  107.          The Network name will appear in the header, displayed at the top of
  108.          each column of the listing for that network. One NDESC entry is
  109.          required for EACH Network you carry. The maximum size of the Network
  110.          Name is 17 characters. The program will support a maximum of 99
  111.          Networks. At least one is mandatory
  112.  
  113. Line 9.  This entry describes the conference numbers to be associated with
  114.          each of the conference descriptions you have defined above. At
  115.          least one is mandatory.
  116.  
  117.          Format|  NETWORK ID:STARTING CONF. #:ENDING CONF. #:CONF. TYPE
  118.          NETWORK ID = Must match one of the IDs in line 8.
  119.          STARTING # = First conference # in a range comprising the network
  120.          ENDING   # = Last  conference # in a range comprising the network
  121.          CONF. TYPE = P for Public Conferences, R for Restricted/Reserved
  122.                       Note: This applies to ALL the conference numbers in the
  123.                             range indicated.
  124.  
  125.          Use multiple NETCONF entries if you have a mixture of Public and
  126.          Reserved. For example: if your RIME conferences covered numbers
  127.          1-100 and #35-37 were Reserved and all others were Public you would
  128.          use 3 NETCONF entries. 1-34 would have a CONF TYPE of P, 35-37 would
  129.          have a CONF TYPE of R and 38-100 would have a CONF TYPE of P. You can
  130.          use any number of NETCONF entries to fully describe your conference
  131.          to a maximum of 150 !
  132.  
  133. Line 10. This entry is used to assign a conference to more than one NETWORK.
  134.          This is mostly cosmetic and is NOT a required entry. In future
  135.          versions this entry will be used by non-PCBoard systems. Optional.
  136.          Format| NETWORK ID:CON. NAME:CONF. #:CONF. TYPE
  137.          NETWORK ID = Must match one of the IDs in line 8.
  138.          CON. NAME  = Conference name up to a maximum of 13 characters
  139.          CONF. #    = Conference number up 3 digits
  140.          CONF. TYPE = Same as Line 9 above
  141.  
  142. -------------------------------------------------------------------------
  143. --- Next 8 Entries Control the Colors For Each Section of the Listing ---
  144. ---------------------- Uses @X Color Codes ------------------------------
  145. -------------------- Registered Version Only ----------------------------
  146. -------------------------------------------------------------------------
  147.  
  148. Line 11. Conference Name Color
  149. Line 12. Conference Type Color
  150. Line 13. Conference Number Color
  151. Line 14. Heading Color (box)
  152. Line 15. Heading BBS Name Color
  153. Line 16. Network Name Color
  154. Line 17. Bottom Line Color
  155. Line 18. "More" Color, on Bottom line (both ends)
  156.  
  157. Line 19. With this entry you can define what appears on the bottom line.
  158.          By default it will show "R = Restricted", in registered version.
  159.          Maximum length is 70 characters. Optional. Requires Registration!
  160.  
  161.  
  162.  
  163.  
  164. __________________________ E X A M P L E ____________________________________
  165. To help make all this a little clearer (it is really very simple), I will
  166. describe the conferences/Networks of my BBS and what the Configuration file
  167. would look like. Sunrise-80 BBS has 4 Networks and Local conferences. The
  168. Networks are RIME, City2City, SmartNet and L&Lnet. Conference numbers are
  169. assigned as follows:
  170.  
  171.            Rime     : 2-23, 25-70, 94 (all are Public except 29,30,35)
  172.            City2City: 73-93 (all are Public except 75,84,86)
  173.            FidoNet  : 1, 71-72, 95-97 (all are Public)
  174.            SmartNet : 98-112 (all are Public)
  175.            Local    : 0, 24 (all are Public)
  176.  
  177. In addition I display my Sunrise Doors conference (conf # 1) in Local area
  178. as well as the FidoNet Network.
  179.  
  180. I also use all the default colors and a special bottom line. All has been
  181. included in the example CFG.
  182.  
  183. The CNFN.CFG file would look like this:
  184. _______________________________________
  185.  
  186. Sunrise-80 BBS
  187. Al Lawrence
  188. 00000000
  189. INPUT=C:\PCB\MAIN\CNAMES.@@@
  190. OUTPUT=C:\PCB\GEN\CNFN
  191. SORT=N
  192. NUMCOL=LEFT
  193. NDESC=100:R I M E
  194. NDESC=200:City2City
  195. NDESC=400:FidoNet
  196. NDESC=300:SmartNet
  197. NDESC=500:L O C A L
  198. NETCONF=200:73:74:P
  199. NETCONF=200:75:75:r
  200. NETCONF=200:76:83:p
  201. NETCONF=200:84:84:r
  202. NETCONF=200:85:85:p
  203. NETCONF=200:86:86:r
  204. NETCONF=200:87:93:p
  205. NETCONF=100:2:23:p
  206. NETCONF=100:25:28:p
  207. NETCONF=100:29:30:r
  208. NETCONF=100:31:34:p
  209. NETCONF=100:35:35:r
  210. NETCONF=100:36:70:p
  211. NETCONF=100:94:94:p
  212. NETCONF=400:1:1:p
  213. NETCONF=400:71:72:p
  214. NETCONF=400:95:97:p
  215. NETCONF=500:0:0:p
  216. NETCONF=500:24:24:p
  217. NETCONF=300:98:112:P
  218. CONF=500:Sunrise Doors:1:p
  219. XCNF=@X06
  220. XTYP=@X07
  221. XCFN=@X0A
  222. XHDB=@X1A
  223. XBBS=@X1F
  224. XNET=@X57
  225. XBBG=@X1F
  226. XMRE=@X8C
  227. BLINE=R = Restricted    [AVAILABLE FROM: Sunrise Doors/Utility Software]
  228.  
  229.  
  230.                         Hints/Tips/Other Ramblings
  231.                         __________________________
  232.  
  233.      (1) The sequence in which the networks appear, is controlled by the
  234.          NETWORK ID field. The program will sort on this field, therefore
  235.          it is important to assign values to each network that will place
  236.          them in the proper sequence. As you can see from the Example
  237.          Sunrise CFG file, above, I use 3 digit numbers.
  238.  
  239.      (2) The first three(3) entries in the CFG file are required to be in
  240.          that sequence. All others may be in any sequence.
  241.  
  242.      (3) This version will handle up to 9999 conferences. Future versions
  243.          will go higher but the number of conferences displayed across the
  244.          screen will be reduced to 3... (can't stretch the screen :) )
  245.  
  246.      (4) Be sure to use the ':' to separate fields within each Entry.
  247.  
  248.      (5) I really do not like to do documentation and therefore there may be
  249.          some errors or omissions in this document. I would appreciate any
  250.          feedback you wish to give relative to the program itself or the Docs.
  251.  
  252.  
  253.                               LEGALITIES
  254.                               __________
  255.  
  256.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  257.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  258.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  259.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  260.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  261.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  262.       OR BREACH OF ANY WARRANTY.
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                              DISTRIBUTION
  269.                              ____________
  270.  
  271.    You may make this file available for downloading from your BBS or you may
  272.    upload it to any BBS of your choice, provided that you do not make any
  273.    changes to the contents of the archive (ZIP file). The archive and its
  274.    individual contents may not be used by any service that charges any money
  275.    whatsoever, without the written permission of the author.
  276.  
  277.  
  278.  
  279.  
  280.  
  281.                              REGISTRATION
  282.                              ____________
  283.  
  284.    Registration and the subsequent insertion of the registration number into
  285.    your configuation file, allows for the display of your BBS name on the
  286.    opening screenand its display in the heading of the listing, reduction of
  287.    delays, and the ability to change certain values in the configuration file.
  288.  
  289.    To register your copy of ACNFN, please fill out the registration form
  290.    (REGISTER.FRM) and mail it along with the registration fee ($20) to the
  291.    name and address on the form.
  292.  
  293.    Be sure to use the proper upper/lower case when filling in your name and
  294.    BBS name, as they MUST match the way you entered them in the configuration
  295.    file.             ^^^^
  296.  
  297.    Based upon information supplied on the registration form, I will pre-
  298.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  299.    up your registration number.
  300.  
  301.  
  302.  
  303.                                  MISC
  304.                                  ____
  305.  
  306.    The latest version of ACNFN and other fine SUNRISE DOOR programs are
  307.    always available for download from SUNRISE-80 BBS.
  308.  
  309.    Remember, should you have any problems, questions or suggestions, be sure
  310.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors,
  311.    PCBHints, SYSops), SmartNet (SN_Sysops), City2City, FIDO (Sysops,
  312.    PCBnet, Sysop18), DoorNet or GeniusNet
  313.